package com.edu.robot.common.service;

import jakarta.validation.constraints.NotNull;

import java.util.List;
import java.util.Map;
import java.util.Set;

public interface RedisUtil {
	/**
	 * 指定缓存过期时间
	 *
	 * @param key  键
	 * @param time 过期时间(秒)
	 */
	void expire(String key, long time);

	/**
	 * 根据key 获取过期时间
	 *
	 * @param key 键 不能为null
	 * @return 时间(秒) 返回0代表为永久有效
	 */
	Long getExpire(@NotNull String key);

	/**
	 * 判断key是否存在
	 *
	 * @param key 键
	 * @return true 存在 false不存在
	 */
	Boolean hasKey(String key);

	/**
	 * 删除缓存
	 *
	 * @param key 要删除的key
	 * @return 如果删除成功则返回true，反之返回false
	 */
	Boolean del(String key);

	/**
	 * 删除缓存
	 *
	 * @param keys 要删除的key的列表
	 * @return 返回删除的key的数量，即受影响的key的个数
	 */
	Long del(List<String> keys);

	//============================String=============================

	/**
	 * 普通缓存获取
	 *
	 * @param key 键
	 * @return 值
	 */
	Object get(String key);

	/**
	 * 普通缓存获取
	 *
	 * @param key 键
	 * @return 值
	 */
	<T> T get(String key, Class<T> clazz);

	/**
	 * 普通缓存放入
	 *
	 * @param key   键
	 * @param value 值
	 */
	void set(String key, Object value);

	/**
	 * 普通缓存放入并设置时间
	 *
	 * @param key   键
	 * @param value 值
	 * @param time  时间(秒) time要大于0 如果time小于等于0 将设置无限期
	 * @return true成功 false 失败
	 */
	Boolean set(String key, Object value, long time);

	/**
	 * 递增
	 *
	 * @param key   键
	 * @param delta 要增加几(大于0)
	 */
	Long incr(String key, long delta);

	/**
	 * 递增，每次增加1
	 *
	 * @param key 键
	 */
	Long incr(String key);

	/**
	 * 递减
	 *
	 * @param key   键
	 * @param delta 要减少几(小于0)
	 */
	Long decr(String key, long delta);

	/**
	 * 递减，每次-1
	 *
	 * @param key 键
	 */
	Long decr(String key);

	/**
	 * 针对字符串类型的数据追加
	 *
	 * @param key    键
	 * @param append 改键对应的值要追加的字符串
	 * @return 返回最终该值的长度
	 */
	Integer append(String key, String append);

	//================================Map=================================

	/**
	 * HashGet
	 *
	 * @param key  键 不能为null
	 * @param item 项 不能为null
	 * @return 值
	 */
	Object hget(String key, String item);

	/**
	 * 获取hashKey对应的所有键值
	 *
	 * @param key 键
	 * @return 对应的多个键值
	 */
	Map<Object, Object> hmget(String key);

	/**
	 * HashSet
	 *
	 * @param key 键
	 * @param map 对应多个键值
	 * @return true 成功 false 失败
	 */
	Boolean hmset(String key, Map<String, Object> map);

	/**
	 * HashSet 并设置时间
	 *
	 * @param key  键
	 * @param map  对应多个键值
	 * @param time 时间(秒)
	 * @return true成功 false失败
	 */
	Boolean hmset(String key, Map<String, Object> map, long time);

	/**
	 * 向一张hash表中放入数据,如果不存在将创建
	 *
	 * @param key   键
	 * @param item  项
	 * @param value 值
	 * @return true 成功 false失败
	 */
	Boolean hset(String key, String item, Object value);

	/**
	 * 向一张hash表中放入数据,如果不存在将创建
	 *
	 * @param key   键
	 * @param item  项
	 * @param value 值
	 * @param time  时间(秒)  注意:如果已存在的hash表有时间,这里将会替换原有的时间
	 * @return true 成功 false失败
	 */
	Boolean hset(String key, String item, Object value, long time);

	/**
	 * 删除hash表中的值
	 *
	 * @param key  键 不能为null
	 * @param item 项 可以使多个 不能为null
	 */
	void hdel(String key, Object... item);

	/**
	 * 判断hash表中是否有该项的值
	 *
	 * @param key  键 不能为null
	 * @param item 项 不能为null
	 * @return true 存在 false不存在
	 */
	Boolean hHasKey(String key, String item);

	/**
	 * hash递增 如果不存在,就会创建一个 并把新增后的值返回
	 *
	 * @param key  键
	 * @param item 项
	 * @param by   要增加几(大于0)
	 */
	Double hincr(String key, String item, double by);

	/**
	 * hash递减
	 *
	 * @param key  键
	 * @param item 项
	 * @param by   要减少记(小于0)
	 */
	double hdecr(String key, String item, double by);

	//============================set=============================

	/**
	 * 根据key获取Set中的所有值
	 *
	 * @param key 键
	 */
	Set<Object> sGet(String key);

	/**
	 * 根据value从一个set中查询,是否存在
	 *
	 * @param key   键
	 * @param value 值
	 * @return true 存在 false不存在
	 */
	Boolean sHasKey(String key, Object value);

	/**
	 * 将数据放入set缓存
	 *
	 * @param key    键
	 * @param values 值 可以是多个
	 * @return 成功个数
	 */
	Long sSet(String key, Object... values);

	/**
	 * 将set数据放入缓存
	 *
	 * @param key    键
	 * @param time   时间(秒)
	 * @param values 值 可以是多个
	 * @return 成功个数
	 */
	Long sSetAndTime(String key, long time, Object... values);

	/**
	 * 获取set缓存的长度
	 *
	 * @param key 键
	 */
	Long sGetSetSize(String key);

	/**
	 * 移除值为value的
	 *
	 * @param key    键
	 * @param values 值 可以是多个
	 * @return 移除的个数
	 */
	Long setRemove(String key, Object... values);
	//===============================list=================================

	/**
	 * 获取list缓存的内容
	 *
	 * @param key   键
	 * @param start 开始
	 * @param end   结束  0 到 -1代表所有值
	 */
	List<Object> lGet(String key, long start, long end);

	/**
	 * 获取list缓存的长度
	 *
	 * @param key 键
	 */
	Long lGetListSize(String key);

	/**
	 * 通过索引 获取list中的值
	 *
	 * @param key   键
	 * @param index 索引  index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
	 */
	Object lGetIndex(String key, long index);

	/**
	 * 将list放入缓存
	 *
	 * @param key   键
	 * @param value 值
	 */
	Long lSet(String key, Object value);

	/**
	 * 将list放入缓存
	 *
	 * @param key   键
	 * @param value 值
	 * @param time  时间(秒)
	 */
	Boolean lSet(String key, Object value, long time);

	/**
	 * 将list放入缓存
	 *
	 * @param key   键
	 * @param value 值
	 */
	Boolean lSet(String key, List<Object> value);

	/**
	 * 将list放入缓存
	 *
	 * @param key   键
	 * @param value 值
	 * @param time  时间(秒)
	 */
	Boolean lSet(String key, List<Object> value, long time);

	/**
	 * 根据索引修改list中的某条数据
	 *
	 * @param key   键
	 * @param index 索引
	 * @param value 值
	 */
	Boolean lUpdateIndex(String key, long index, Object value);

	/**
	 * 移除N个值为value
	 *
	 * @param key   键
	 * @param count 移除多少个
	 * @param value 值
	 * @return 移除的个数
	 */
	Long lRemove(String key, long count, Object value);

	/**
	 * 模糊查询获取key值
	 */
	Set<String> keys(String pattern);

	/**
	 * 使用Redis的消息队列
	 *
	 * @param message 消息内容
	 */
	void convertAndSend(String channel, Object message);


	//=========BoundListOperations 用法 start============

	/**
	 * 将数据添加到Redis的list中（从右边添加）
	 *
	 * @param duration 有效期时间
	 * @param values   待添加的数据
	 */
	void addToListRight(String listKey, long duration, Object... values);

	/**
	 * 根据起始结束序号遍历Redis中的list
	 *
	 * @param start 起始序号
	 * @param end   结束序号
	 */
	List<Object> rangeList(String listKey, long start, long end);

	/**
	 * 弹出右边的值 --- 并且移除这个值
	 */
	Object rifhtPop(String listKey);


}
